home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / programm.ing / ams__l~1.zoo / man / spr.man < prev    next >
Encoding:
Text File  |  1993-09-05  |  4.4 KB  |  111 lines
  1.                         ATARI MACHINE SPECIFIC LIBRARY
  2.  
  3.  
  4.  
  5. NAME
  6.      spr - a simple Sprite generator.
  7.  
  8. SYNOPSIS
  9.      spr {command}
  10.  
  11.        commands:
  12.          D SPheight ImgW ImgH        Set dimensions
  13.          I imagefile                 Load image file
  14.          S savefile                  Set sprite save file
  15.          R #rotations                Set # rotations
  16.          s #incarnations             New sprite
  17.          r from hotx hoty            Add n rotated incarnations
  18.          m from hotx hoty            Add shrunk incarnation
  19.          d from hotx hoty            Add direct incarnation
  20.          a accuracy                  Set pixel subdivision
  21.          f features                  Set current features
  22.              (w=wide, f=fast)
  23.  
  24. DESCRIPTION
  25.      spr is a "batch" mode sprite creator.  That is, you give it a
  26.      description of everything you want, and it gives that back to
  27.      you - it is not interactive... except that pressing any key
  28.      during running will abort the program (rotations can take a
  29.      LONG time).
  30.  
  31.      This mode of operation is particularly suited to the "makefile"
  32.      concept.
  33.  
  34. USAGE
  35.      First, create some Degas or CrackArt picture files with the
  36.      following format:
  37.  
  38.        Draw a 1-pixel-wide frame, outlining an area. (eg. a 32x32 pixel
  39.          area)
  40.  
  41.        Draw you sprite either:
  42.          - Magnified (eg. draw a 16x16 sprite in a 32x32 space)
  43.          - Unmagnified (eg. draw a 16x16 sprite in a 16x16 space)
  44.  
  45.        Run spr.  Some examples follow:
  46.  
  47.          spr f f I foo.pi1 D 2 16 2 S foo.spr s 1 m 0 8.0 1.0
  48.  
  49.            f f         = Fast (ie. preshifted) sprites.
  50.            I foo.pi1   = Use the source image file "foo.pi1".
  51.            D 2 16 2    = Generate 2 pixel high sprites from
  52.                           16x2 pixel framed images.  (the width of the
  53.                           sprite will be 16, since "Wide" was not enabled
  54.                           with "f w").
  55.            S foo.spr   = Use the destination sprite file "foo.spr".
  56.            s 1         = Start a new sprite, with 1 incarnation.
  57.            m 0 8.0 1.0 = Add a magnified incarnation, using frame #0 in
  58.                           the source image file, with hotspot (8,1).  Since
  59.                           the destination sprite size (16x2) is the same as
  60.                           the source image size (16x2), no actual magnification
  61.                           is done.
  62.  
  63.  
  64.          spr a 8 I bar.ca1 R 64 D 16 32 32 S bar.spr s 320 r 0 8.0 8.0
  65.                    r 1 8.0 8.0 r 2 8.0 8.0 r 3 8.0 8.0 r 4 8.0 8.0 
  66.  
  67.            a 8         = Use 8x pixel subdivision - accurate, but slow.
  68.            I bar.ca1   = Use the source image file "bar.ca1".
  69.            R 64        = Create 64 rotations in the "r" command.
  70.            D 16 32 32  = Create 16 pixel high sprites from 32x32 pixel
  71.                           framed images.  The width will be 16, since
  72.                           the wide feature was not enabled.
  73.            S bar.spr   = Use the destination sprite file "bar.spr".
  74.            s 320       = Start a new sprite, with 320 incarnations.
  75.            r 0 8.0 8.0 = Add (64, defined above) rotated incarnations,
  76.                           using framed #0 in the source image, with
  77.                           hotspot (8,8).  Note that with rotations, the
  78.                           hotspot is rotated.
  79.            r * 8.0 8.0 = add more rotated images.
  80.  
  81. NOTES FOR MAKEFILES
  82.      Remember that in makefiles, a "\" character at the end of the
  83.      line allows more command-line to be added on the next line, so
  84.      you may give quite large lists of commands to spr.
  85.  
  86. FILES
  87.      ".spr" is the recommended extension for AMS sprites.
  88.  
  89. BUGS
  90.      The "hotspot" definition may be confusing in that it is given
  91.      in terms of the destination image, rather than the source.
  92.  
  93.      RGB comparisons are used to find "closest colour".  Other, more
  94.      theoretically correct methods exist - even HSL comparison may be
  95.      better.  But it works okay.
  96.  
  97. AUTHOR
  98.      Warwick Allison, 1992.
  99.      warwick@cs.uq.oz.au
  100.  
  101. COPYING
  102.      This functionality is part of the Atari Machine Specific Library,
  103.      and is Copyright 1992 by Warwick W. Allison.
  104.  
  105.      The Atari Machine Specific Library is free and protected under the
  106.      GNU Library General Public License.
  107.  
  108.      You are free to copy and modify these sources, provided you acknowledge
  109.      the origin by retaining this notice, and adhere to the conditions
  110.      described in the GNU LGPL.
  111.